Home > API > Clients > Post Post > V1 > Clients > {clientid} > Customers > Searching in customers with given filter value.

Searching in customers with given filter value.

Returns a list of customers. The customers are returned sorted by customer number as default.

PATH:

/v1/clients/{clientId}/customers/search

PATH PARAMETERS:

clientId
required

integer

The ID of the client.

REQUEST BODY SCHEMA:

searchValue

string

Specifies the keyword to search.
searchColumn

string

Specifies the column name to search.\Available values:

  • clientId
  • customerNumber
  • name
  • ssn
  • organizationNumber

RESPONSES:

200 List of found customers

RESPONSE SCHEMA:

items

array of items

no description in swagger file
Array () [
_links

array of _links

no description in swagger file
Array () [
href

string

Href for the object being described by the link in the form of a URI
rel

string

The relationship between the object being returned and the object described by the link.
method

string

ActionVerb OR HttpMethod

]
customerNumber

string

The ID of the customer.
type

string

Enum: Person Company Undefined

no description in swagger file
person

person object

Legal information of the person.
firstName

string

The first name of the person.
lastName

string

The last name of the person.
company

company object

The organization info of the company.
name

string

The name of the company.
organizationNumber

string

The organization number of the company.
phoneNumber

string

Optional. The phone number of the person/company.
email

string

Optional. The email address of the person/company.
paymentMeans

paymentMeans object

The ID list of payment methods (e.g. card).
paymentId

string

The ID of payment
address

address object

The address of the customer.
addressLine

string

Address line 1 (e.g., street, PO Box, or company name).
addressLine2

string

Optional. Address line 2 (e.g., apartment, suite, unit, or building).
addressLine3

string

Optional. Address line 3.
postalCode

string

ZIP or postal code.
postalPlace

string

State, county, province, or region.
countryCode

string

Two-letter country code.

]
total

integer int32

no description in swagger file
401 Unauthorized

RESPONSE SCHEMA:

type

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
title

string

A short, human-readable summary of the problem.
details

string

A human-readable explanation specific to this occurrence of the problem.
category

string

Enum: BusinessError TechnicalError

no description in swagger file
403 Forbidden

RESPONSE SCHEMA:

type

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.
title

string

A short, human-readable summary of the problem.
details

string

A human-readable explanation specific to this occurrence of the problem.
category

string

Enum: BusinessError TechnicalError

no description in swagger file

Path

post

/v1/clients/{clientId}/customers/search

Request samples

  • {
    • "searchValue": "string",
    • "searchColumn": "string"
  • }

Response samples

200401403
  • {
    • "items": [ ...
      • {
        • "_links": [ ...
          • {
            • "href": "string",
            • "rel": "string",
            • "method": "string"
            }
          ],
        • "customerNumber": "string",
        • "type": "string",
        • "person": { ...
          • "firstName": "string",
          • "lastName": "string"
          },
        • "company": { ...
          • "name": "string",
          • "organizationNumber": "string"
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "paymentMeans": { ...
          • "paymentId": "string"
          },
        • "address": { ...
          • "addressLine": "string",
          • "addressLine2": "string",
          • "addressLine3": "string",
          • "postalCode": "string",
          • "postalPlace": "string",
          • "countryCode": "string"
          }
        }
      ],
    • "total": 1
    }
  • {
    • "type": "string",
    • "title": "string",
    • "details": "string",
    • "category": "string"
    }
  • {
    • "type": "string",
    • "title": "string",
    • "details": "string",
    • "category": "string"
    }